﻿#region license
// Copyright (c) 2008 - 2008 Ritesh Rao
// All rights reserved.
// 
// Redistribution and use in source and binary forms, with or without modification,
// are permitted provided that the following conditions are met:
// 
//     * Redistributions of source code must retain the above copyright notice,
//     this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above copyright notice,
//     this list of conditions and the following disclaimer in the documentation
//     and/or other materials provided with the distribution.
//     * Neither the name of Ayende Rahien nor the names of its
//     contributors may be used to endorse or promote products derived from this
//     software without specific prior written permission.
// 
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
// FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
// DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
// CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
// OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
// THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#endregion

namespace Rhinestone.Domain
{
    /// <summary>
    /// A generic interface to represent a user in Rhinestone.
    /// </summary>
    /// <remarks>
    /// The model doesn't concern itself of user management, membershio and role management. Instead
    /// it assumes that someother service / component, such as an identity subsustem, will take care 
    /// of this and provide an implementation of <see cref="IUser"/> that represents a valid
    /// user.
    /// </remarks>
    public interface IUser
    {
        /// <summary>
        /// Gets the unique name of the user.
        /// </summary>
        /// <remarks>
        /// Implementors of this interface must return a valid, non-null and unique value for the
        /// <see cref="UserName"/> property. This property should uniquely identify the user entity.
        /// This property must be implemented.
        /// </remarks>
        string UserName {get;}
        /// <summary>
        /// Gets a boolean value indicating whether the user is an administrator of Rhinestone and should
        /// have administrative access.
        /// </summary>
        /// <remarks>
        /// Implementors of this interface must return true when the user should have administrative access
        /// to Rhinestone, else return false. This property must be implemented.
        /// </remarks>
        bool IsAdministrator {get;}

        /// <summary>
        /// Gets the first name of the user.
        /// </summary>
        /// <value>string. The first name of the user.</value>
        string FirstName { get; }

        /// <summary>
        /// Gets the last name of the user.
        /// </summary>
        /// <value>string. The last name of the user.</value>
        string LastName { get; }
    }
}
